-
Notifications
You must be signed in to change notification settings - Fork 3
docs(tenant-management): update the readme #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
5c9f940 to
a466394
Compare
|
|
||
| ```typecript | ||
| this.bind(TenantManagementServiceBindings.Config).to({ | ||
| useCustomSequence:true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
useSymmetric hoga , check again
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
|
|
||
| **Tenants** - main model of the service that represents a tenant in the system, either pooled or siloed | ||
|
|
||
| **TenantsConfig** - to save any tenant specific data related to idP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TenantConfig model is being deleted in this pr, but mentioned here in models section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
|
|
||
| **Invoice** - this model represents an invoice with the amount and period generated for a tenant in the system | ||
|
|
||
| **Leads** - this model represents a lead that could eventually be a tenant in the system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update the db schema
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
|
|
||
| When a new tenant is provisioned, the provider automatically: | ||
| - Creates a Realm in Keycloak for that tenant. | ||
| (Each tenant gets its own isolated authentication space.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add auth0 details as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
1cf04af to
7de74ef
Compare
| ## Direct Tenant Onboarding | ||
|
|
||
| In addition to the lead-based onboarding flow, a new tenant can also be onboarded directly without creating a lead first. | ||
| This capability is designed specifically for control plane administrators, who can create and provision tenants directly through the management APIs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mention the endpoint here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
| ## Event Publishing | ||
| This service now supports pluggable event strategies — EventBridge, SQS, and BullMQ — through the loopback4-message-bus-connector. | ||
|
|
||
| The service supports pluggable event strategies — EventBridge, SQS, and BullMQ — through the loopback4-message-bus-connector. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link the package here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
7de74ef to
3203b4f
Compare
|



Description
Updated the tenant management service README file
Fixes #109
GH-109
Type of change
Please delete options that are not relevant.
Checklist: